/*
 * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
 * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */

package java.lang.reflect;

import java.security.AccessController;
import sun.reflect.LangReflectAccess;
import sun.reflect.ReflectionFactory;

/**
 * Modifier 类提供 {@code static} 方法和常量来解码类和成员访问修饰符。
 * 修饰符集合表示为整数，不同的位位置表示不同的修饰符。
 * 表示修饰符的常量值取自 <cite>Java&trade; 虚拟机规范</cite>
 * 第 4.1、4.4、4.5 和 4.7 节的表格。
 *
 * @see Class#getModifiers()
 * @see Member#getModifiers()
 *
 * @author Nakul Saraiya
 * @author Kenneth Russell
 */
public class Modifier {

    /*
     * Bootstrapping protocol between java.lang and java.lang.reflect
     *  packages
     */
    static {
        sun.reflect.ReflectionFactory factory =
            AccessController.doPrivileged(
                new ReflectionFactory.GetReflectionFactoryAction());
        factory.setLangReflectAccess(new java.lang.reflect.ReflectAccess());
    }

    /**
     * 如果整数参数包含 {@code public} 修饰符，则返回 {@code true}，否则返回 {@code false}。
     *
     * @param   mod 修饰符集合
     * @return 如果 {@code mod} 包含 {@code public} 修饰符则返回 {@code true}；否则返回 {@code false}。
     */
    public static boolean isPublic(int mod) {
        return (mod & PUBLIC) != 0;
    }

    /**
     * 如果整数参数包含 {@code private} 修饰符，则返回 {@code true}，否则返回 {@code false}。
     *
     * @param   mod 修饰符集合
     * @return 如果 {@code mod} 包含 {@code private} 修饰符则返回 {@code true}；否则返回 {@code false}。
     */
    public static boolean isPrivate(int mod) {
        return (mod & PRIVATE) != 0;
    }

    /**
     * 如果整数参数包含 {@code protected} 修饰符，则返回 {@code true}，否则返回 {@code false}。
     *
     * @param   mod 修饰符集合
     * @return 如果 {@code mod} 包含 {@code protected} 修饰符则返回 {@code true}；否则返回 {@code false}。
     */
    public static boolean isProtected(int mod) {
        return (mod & PROTECTED) != 0;
    }

    /**
     * 如果整数参数包含 {@code static} 修饰符，则返回 {@code true}，否则返回 {@code false}。
     *
     * @param   mod 修饰符集合
     * @return 如果 {@code mod} 包含 {@code static} 修饰符则返回 {@code true}；否则返回 {@code false}。
     */
    public static boolean isStatic(int mod) {
        return (mod & STATIC) != 0;
    }

    /**
     * 如果整数参数包含 {@code final} 修饰符，则返回 {@code true}，否则返回 {@code false}。
     *
     * @param   mod 修饰符集合
     * @return 如果 {@code mod} 包含 {@code final} 修饰符则返回 {@code true}；否则返回 {@code false}。
     */
    public static boolean isFinal(int mod) {
        return (mod & FINAL) != 0;
    }

    /**
     * 如果整数参数包含 {@code synchronized} 修饰符，则返回 {@code true}，否则返回 {@code false}。
     *
     * @param   mod 修饰符集合
     * @return 如果 {@code mod} 包含 {@code synchronized} 修饰符则返回 {@code true}；否则返回 {@code false}。
     */
    public static boolean isSynchronized(int mod) {
        return (mod & SYNCHRONIZED) != 0;
    }

    /**
     * 如果整数参数包含 {@code volatile} 修饰符，则返回 {@code true}，否则返回 {@code false}。
     *
     * @param   mod 修饰符集合
     * @return 如果 {@code mod} 包含 {@code volatile} 修饰符则返回 {@code true}；否则返回 {@code false}。
     */
    public static boolean isVolatile(int mod) {
        return (mod & VOLATILE) != 0;
    }

    /**
     * 如果整数参数包含 {@code transient} 修饰符，则返回 {@code true}，否则返回 {@code false}。
     *
     * @param   mod 修饰符集合
     * @return 如果 {@code mod} 包含 {@code transient} 修饰符则返回 {@code true}；否则返回 {@code false}。
     */
    public static boolean isTransient(int mod) {
        return (mod & TRANSIENT) != 0;
    }

    /**
     * 如果整数参数包含 {@code native} 修饰符，则返回 {@code true}，否则返回 {@code false}。
     *
     * @param   mod 修饰符集合
     * @return 如果 {@code mod} 包含 {@code native} 修饰符则返回 {@code true}；否则返回 {@code false}。
     */
    public static boolean isNative(int mod) {
        return (mod & NATIVE) != 0;
    }

    /**
     * 如果整数参数包含 {@code interface} 修饰符，则返回 {@code true}，否则返回 {@code false}。
     *
     * @param   mod 修饰符集合
     * @return 如果 {@code mod} 包含 {@code interface} 修饰符则返回 {@code true}；否则返回 {@code false}。
     */
    public static boolean isInterface(int mod) {
        return (mod & INTERFACE) != 0;
    }

    /**
     * 如果整数参数包含 {@code abstract} 修饰符，则返回 {@code true}，否则返回 {@code false}。
     *
     * @param   mod 修饰符集合
     * @return 如果 {@code mod} 包含 {@code abstract} 修饰符则返回 {@code true}；否则返回 {@code false}。
     */
    public static boolean isAbstract(int mod) {
        return (mod & ABSTRACT) != 0;
    }

    /**
     * 如果整数参数包含 {@code strictfp} 修饰符，则返回 {@code true}，否则返回 {@code false}。
     *
     * @param   mod 修饰符集合
     * @return 如果 {@code mod} 包含 {@code strictfp} 修饰符则返回 {@code true}；否则返回 {@code false}。
     */
    public static boolean isStrict(int mod) {
        return (mod & STRICT) != 0;
    }

    /**
     * 返回描述指定修饰符中访问修饰符标志的字符串。例如：
     * <blockquote><pre>
     *    public final synchronized strictfp
     * </pre></blockquote>
     * 修饰符名称按照 <cite>Java&trade; 语言规范</cite> 第 8.1.1、8.3.1、8.4.3、8.8.3
     * 和 9.1.1 节中给出的建议修饰符顺序返回。
     * 此方法使用的完整修饰符顺序是：
     * <blockquote> {@code
     * public protected private abstract static final transient
     * volatile synchronized native strictfp
     * interface } </blockquote>
     * 此类中讨论的 {@code interface} 修饰符不是 Java 语言中的真正修饰符，
     * 它出现在此方法列出的所有其他修饰符之后。此方法可能返回不是 Java 实体
     * 有效修饰符的修饰符字符串；换句话说，不会检查输入所表示的修饰符组合的可能有效性。
     *
     * 请注意，要对已知类型的实体（如构造器或方法）执行此类检查，
     * 首先将 {@code toString} 的参数与来自 {@link #constructorModifiers}
     * 或 {@link #methodModifiers} 等方法的适当掩码进行 AND 运算。
     *
     * @param   mod 修饰符集合
     * @return  {@code mod} 所表示的修饰符集合的字符串表示
     */
    public static String toString(int mod) {
        StringBuilder sb = new StringBuilder();
        int len;

        if ((mod & PUBLIC) != 0)        sb.append("public ");
        if ((mod & PROTECTED) != 0)     sb.append("protected ");
        if ((mod & PRIVATE) != 0)       sb.append("private ");

        /* Canonical order */
        if ((mod & ABSTRACT) != 0)      sb.append("abstract ");
        if ((mod & STATIC) != 0)        sb.append("static ");
        if ((mod & FINAL) != 0)         sb.append("final ");
        if ((mod & TRANSIENT) != 0)     sb.append("transient ");
        if ((mod & VOLATILE) != 0)      sb.append("volatile ");
        if ((mod & SYNCHRONIZED) != 0)  sb.append("synchronized ");
        if ((mod & NATIVE) != 0)        sb.append("native ");
        if ((mod & STRICT) != 0)        sb.append("strictfp ");
        if ((mod & INTERFACE) != 0)     sb.append("interface ");

        if ((len = sb.length()) > 0)    /* trim trailing space */
            return sb.toString().substring(0, len-1);
        return "";
    }

    /*
     * Access modifier flag constants from tables 4.1, 4.4, 4.5, and 4.7 of
     * <cite>The Java&trade; Virtual Machine Specification</cite>
     */

    /**
     * 表示 {@code public} 修饰符的 {@code int} 值。
     */
    public static final int PUBLIC           = 0x00000001;

    /**
     * 表示 {@code private} 修饰符的 {@code int} 值。
     */
    public static final int PRIVATE          = 0x00000002;

    /**
     * 表示 {@code protected} 修饰符的 {@code int} 值。
     */
    public static final int PROTECTED        = 0x00000004;

    /**
     * 表示 {@code static} 修饰符的 {@code int} 值。
     */
    public static final int STATIC           = 0x00000008;

    /**
     * 表示 {@code final} 修饰符的 {@code int} 值。
     */
    public static final int FINAL            = 0x00000010;

    /**
     * 表示 {@code synchronized} 修饰符的 {@code int} 值。
     */
    public static final int SYNCHRONIZED     = 0x00000020;

    /**
     * 表示 {@code volatile} 修饰符的 {@code int} 值。
     */
    public static final int VOLATILE         = 0x00000040;

    /**
     * 表示 {@code transient} 修饰符的 {@code int} 值。
     */
    public static final int TRANSIENT        = 0x00000080;

    /**
     * 表示 {@code native} 修饰符的 {@code int} 值。
     */
    public static final int NATIVE           = 0x00000100;

    /**
     * 表示 {@code interface} 修饰符的 {@code int} 值。
     */
    public static final int INTERFACE        = 0x00000200;

    /**
     * 表示 {@code abstract} 修饰符的 {@code int} 值。
     */
    public static final int ABSTRACT         = 0x00000400;

    /**
     * 表示 {@code strictfp} 修饰符的 {@code int} 值。
     */
    public static final int STRICT           = 0x00000800;

    // Bits not (yet) exposed in the public API either because they
    // have different meanings for fields and methods and there is no
    // way to distinguish between the two in this class, or because
    // they are not Java programming language keywords
    static final int BRIDGE    = 0x00000040;
    static final int VARARGS   = 0x00000080;
    static final int SYNTHETIC = 0x00001000;
    static final int ANNOTATION  = 0x00002000;
    static final int ENUM      = 0x00004000;
    static final int MANDATED  = 0x00008000;
    static boolean isSynthetic(int mod) {
      return (mod & SYNTHETIC) != 0;
    }

    static boolean isMandated(int mod) {
      return (mod & MANDATED) != 0;
    }

    // Note on the FOO_MODIFIERS fields and fooModifiers() methods:
    // the sets of modifiers are not guaranteed to be constants
    // across time and Java SE releases. Therefore, it would not be
    // appropriate to expose an external interface to this information
    // that would allow the values to be treated as Java-level
    // constants since the values could be constant folded and updates
    // to the sets of modifiers missed. Thus, the fooModifiers()
    // methods return an unchanging values for a given release, but a
    // value that can potentially change over time.

    /**
     * 可以应用于类的 Java 源码修饰符。
     * @jls 8.1.1 Class Modifiers
     */
    private static final int CLASS_MODIFIERS =
        Modifier.PUBLIC         | Modifier.PROTECTED    | Modifier.PRIVATE |
        Modifier.ABSTRACT       | Modifier.STATIC       | Modifier.FINAL   |
        Modifier.STRICT;

    /**
     * 可以应用于接口的 Java 源码修饰符。
     * @jls 9.1.1 Interface Modifiers
     */
    private static final int INTERFACE_MODIFIERS =
        Modifier.PUBLIC         | Modifier.PROTECTED    | Modifier.PRIVATE |
        Modifier.ABSTRACT       | Modifier.STATIC       | Modifier.STRICT;


    /**
     * 可以应用于构造器的 Java 源码修饰符。
     * @jls 8.8.3 Constructor Modifiers
     */
    private static final int CONSTRUCTOR_MODIFIERS =
        Modifier.PUBLIC         | Modifier.PROTECTED    | Modifier.PRIVATE;

    /**
     * 可以应用于方法的 Java 源码修饰符。
     * @jls 8.4.3 Method Modifiers
     */
    private static final int METHOD_MODIFIERS =
        Modifier.PUBLIC         | Modifier.PROTECTED    | Modifier.PRIVATE |
        Modifier.ABSTRACT       | Modifier.STATIC       | Modifier.FINAL   |
        Modifier.SYNCHRONIZED   | Modifier.NATIVE       | Modifier.STRICT;

    /**
     * 可以应用于字段的 Java 源码修饰符。
     * @jls 8.3.1 Field Modifiers
     */
    private static final int FIELD_MODIFIERS =
        Modifier.PUBLIC         | Modifier.PROTECTED    | Modifier.PRIVATE |
        Modifier.STATIC         | Modifier.FINAL        | Modifier.TRANSIENT |
        Modifier.VOLATILE;

    /**
     * 可以应用于方法或构造器参数的 Java 源码修饰符。
     * @jls 8.4.1 Formal Parameters
     */
    private static final int PARAMETER_MODIFIERS =
        Modifier.FINAL;

    /**
     *
     */
    static final int ACCESS_MODIFIERS =
        Modifier.PUBLIC | Modifier.PROTECTED | Modifier.PRIVATE;

    /**
     * 返回将可以应用于类的源语言修饰符进行 OR 运算的 {@code int} 值。
     * @return 将可以应用于类的源语言修饰符进行 OR 运算的 {@code int} 值。
     *
     * @jls 8.1.1 Class Modifiers
     * @since 1.7
     */
    public static int classModifiers() {
        return CLASS_MODIFIERS;
    }

    /**
     * 返回将可以应用于接口的源语言修饰符进行 OR 运算的 {@code int} 值。
     * @return 将可以应用于接口的源语言修饰符进行 OR 运算的 {@code int} 值。
     *
     * @jls 9.1.1 Interface Modifiers
     * @since 1.7
     */
    public static int interfaceModifiers() {
        return INTERFACE_MODIFIERS;
    }

    /**
     * 返回将可以应用于构造器的源语言修饰符进行 OR 运算的 {@code int} 值。
     * @return 将可以应用于构造器的源语言修饰符进行 OR 运算的 {@code int} 值。
     *
     * @jls 8.8.3 Constructor Modifiers
     * @since 1.7
     */
    public static int constructorModifiers() {
        return CONSTRUCTOR_MODIFIERS;
    }

    /**
     * 返回将可以应用于方法的源语言修饰符进行 OR 运算的 {@code int} 值。
     * @return 将可以应用于方法的源语言修饰符进行 OR 运算的 {@code int} 值。
     *
     * @jls 8.4.3 Method Modifiers
     * @since 1.7
     */
    public static int methodModifiers() {
        return METHOD_MODIFIERS;
    }

    /**
     * 返回将可以应用于字段的源语言修饰符进行 OR 运算的 {@code int} 值。
     * @return 将可以应用于字段的源语言修饰符进行 OR 运算的 {@code int} 值。
     *
     * @jls 8.3.1 Field Modifiers
     * @since 1.7
     */
    public static int fieldModifiers() {
        return FIELD_MODIFIERS;
    }

    /**
     * 返回将可以应用于参数的源语言修饰符进行 OR 运算的 {@code int} 值。
     * @return 将可以应用于参数的源语言修饰符进行 OR 运算的 {@code int} 值。
     *
     * @jls 8.4.1 Formal Parameters
     * @since 1.8
     */
    public static int parameterModifiers() {
        return PARAMETER_MODIFIERS;
    }
}
